home *** CD-ROM | disk | FTP | other *** search
/ Macwelt 1 / Macwelt DVD 1.toast / Web-Publishing / HTML-Editoren / Alpha ƒ / Help / Mode Examples Help < prev    next >
Encoding:
Text File  |  2000-11-30  |  35.9 KB  |  948 lines
  1.  
  2. Mode Examples Help
  3.  
  4.  
  5.                                                version: 2.2
  6.                                                created: 04/08/00 {12:46:41 am}
  7.                                            last update: 11/30/00 {08:11:08 pm}
  8.                                
  9.  
  10.           Introduction
  11.  
  12.  
  13. This document describes the contents of the folder Mode Examples, included
  14. as a part of the Alpha distribution.  This folder is not an essential
  15. component of the software.  Removing it, however, will not reduce the
  16. memory requirements of the program, and will only save disk space.
  17.  
  18. Alpha is a mode-based text editor.  This means that its behavior can change
  19. depending on the type of file that one has opened.  A LaTeX file, for
  20. example, with a file suffix .tex, will induce Alpha to load special LaTeX
  21. menus, colorize keywords, and adopt a particular indenting scheme.  Other
  22. modes are specific to html files, or various programming / syntax
  23. languages.  Several modes have been installed with their own Help files.
  24.  
  25. The links below open the example files in a shell window which you can
  26. modify at your liesure to explore a mode's schema for colorizing, file
  27. marking, indenting, etc.  None of the changes you make will affect the
  28. actual file.  If you close the window and then click on the hyperlink
  29. again, you will start with the same example as before.
  30.  
  31. Many of Alpha's modes have been submitted by users, and are being
  32. continually revised and updated.  The "Alpha Manual" contains more
  33. information on how determine what packages you have available, as well as
  34. how to find and install additional modes that might not be part of the
  35. "official" distribution.  The file "Extending Alpha" explains how you could
  36. write additional modes, menus or features yourself.
  37.  
  38. IMPORTANT: This help file is auto-marking, intended for Alpha versions 7.4
  39. and above, and Alphatk.  Many of the hyperlinks will not work for other
  40. versions.  A 7.3 compatible version of this file can be found at
  41.  
  42.     <http://www.princeton.edu/~cupright/computing/alpha/>
  43.  
  44. The most recent version of Alpha can be downloaded from
  45.  
  46.     <ftp://ftp.ucsd.edu/pub/alpha/>
  47.  
  48.  
  49.           Navigating Hyperlinks
  50.  
  51.  
  52. In this document, the examples in green are hyperlinks to examples for the
  53. specified mode.  When you move your mouse over the link, the cursor will
  54. turn into a magnifying glass, and clicking will load the proper mode and
  55. open up the file.  Those in black are still waiting for a contribution --
  56. if you have a worthy example, the last section of this file contains an
  57. e-mail address for making submissions.  Other hyperlinks refer to either
  58. help manuals installed with Alpha, or www links.
  59.  
  60. This file is a special colorized example of Text mode -- at the right of
  61. the status bar on the bottom of your screen you'll see a pop-up menu box
  62. which currently states 'Text'.  This menu lists all of the modes currently
  63. installed, and allows you to change the mode of the frontmost window.  If
  64. the Example file refers to a mode that is not installed, Alpha will open it
  65. in 'Text' mode by default.
  66.  
  67.  
  68.           Macintosh memory, Modes, and Crashes
  69.  
  70.  
  71. One reason that Alpha has a smaller footprint of RAM is that it only loads
  72. "extra" modes when called upon to do so.  However, every time that Alpha
  73. does load a new mode, this increases its memory requirements -- load enough
  74. of them and you might cause the program (as well as your cpu) to crash. 
  75. This is especially true if the modes in question have numerous extra
  76. features and/or menus.
  77.  
  78. For this reason, and depending on the relative power of your computer, you
  79. should not open all of these examples in one session.  If the beach ball
  80. starts to turn very slowly as Alpha is loading a mode, you should consider
  81. saving and closing all Alpha windows, quitting and restarting the program. 
  82. You can increase Alpha's memory partition (but only when the program is not
  83. open) by clicking once on the Alpha application and opening the Finder's 
  84. ' File --> Get Info ' window.
  85.  
  86.           
  87.     ======================================================================
  88.  
  89.  
  90.           LaTeX and HTML Examples
  91.  
  92.  
  93. The LaTeX and HTML examples below not only demonstrate Alpha's behavior for
  94. the modes, they can also serve as introductions to the markup languages.
  95.  
  96.  
  97.                LaTeX Example
  98.  
  99. TeX mode, for the family of TeX and LaTeX files.
  100.  
  101. (This includes .tex, .sty, .cls, .bst  etc.  files.)
  102.                     
  103. "LaTeX Example.tex"             "TeX Help"
  104.  
  105. This example is David R. Wilkins' Getting Started with LaTeX, a 45 page
  106. introduction to Leslie Lamport's set of extensions to Donald Knuth's TeX
  107. typesetting program.  This is a self-contained LaTeX file, which does not
  108. rely upon any extra .sty files.  If one has already installed a LaTeX
  109. processing software package, such as OzTeX or CMacTeX, one could process
  110. the actual file contained in the Mode Examples folder "LaTeX-Example.tex"
  111. (rather than the hyperlink above) and obtain an excellent manual for LaTeX.
  112.  
  113.  
  114.                BibTeX Example
  115.  
  116. Bib mode, for LaTeX bibliography files.
  117.  
  118. "BibTeX Example.bib"            "Bib Help"
  119.  
  120. This file is a compendium of books on computer languages and programming.
  121.  
  122. The Bib mode can also convert .bib files to .html or .refer (EndNote), and
  123. can also convert some formats such as .hollis or .inspec to .bib .  See the
  124. "BibTeX Help" file for details -- this distribution of the Mode Examples
  125. also includes a "Hollis-Example.hollis" example file.
  126.  
  127.  
  128.                HTML Example
  129.  
  130. HTML mode, for the family of World Wide Web html files.
  131.  
  132. (This includes .shtml, .css, .js files.)
  133.  
  134. "HTML Example.html"             "HTML Help"
  135.  
  136. This example is the NSCA's A Beginner's Guide to html, which sets forth the
  137. required elements of a standard html web page, as well as additional tags
  138. that one might use for stylistic or formatting purposes.  If one opened the
  139. actual file in the Mode Examples folder "HTML-Example.html" instead of the
  140. above hyperlink, it could then be sent to the defined web browser.
  141.  
  142.  
  143.                CSS Example
  144.  
  145. CSS mode, for (html) cascading style sheets.  
  146.  
  147. "CSS Example.css"               "CSS Help"
  148.  
  149.  
  150.                JavaScript Example
  151.  
  152. JScr mode, for (html) javascript scripts.  
  153.  
  154. "JavaScript Example.js"         "JScr Help"
  155.  
  156.           
  157.     ======================================================================
  158.  
  159.  
  160.           Programming / Syntax Examples
  161.  
  162.  
  163. Some of the annotation comes from the University of Montana "Language Finger"
  164. at <http://www.lib.umt.edu/guide/lang/langfing.htm>  (UMLF).  Most of the rest 
  165. comes from program specific web sites.
  166.  
  167.  
  168.                Ada Example
  169.  
  170. Ada mode, for the Ada programming language.
  171.  
  172. "Ada Example.ada"               "Ada Help"
  173.  
  174. In the 1960s and 1970s, the United States Department of Defense was using
  175. more than 2,000 languages for its mission-critical programming.  Most of
  176. these were languages that were developed for one specific job.  Finally, in
  177. 1975, the DoD formed the U.S. Department of Defense High-Order Language
  178. Working Group (HOLWG) to find a solution to what was often called the
  179. "software crisis."
  180.  
  181. Rather than create this new language themselves, they decided to hold a
  182. contest.  Coincidentally, all of the teams created Pascal-based languages. 
  183. In the end, the winner was CII Honeywell-Bull in France.  Eventually, the
  184. language was christened "Ada," in honor of Lady Ada Lovelace, daughter of
  185. famed poet Lord Byron and assistant to mathematician Charles Babbage, who
  186. invented the Analytical Machine.  Lady Ada is often considered to be the
  187. world's first programmer.
  188.  
  189. By 1990, over 200 validated Ada compilers had been produced, and in 1995 a
  190. new standard, called Ada 95, was announced.  Ada 95 is object-oriented, and
  191. offers interfaces to the languages C, FORTRAN and COBOL.
  192.  
  193.                                         -- <http://www.adahome.com>
  194.  
  195.                AppleScript Example
  196.  
  197. Scrp mode, for Applescript scripts.
  198.  
  199. "AppleScript Example.script"    "Scrp Help"
  200.  
  201. AppleScript is an English-like language used to write script files which
  202. can control the actions of the computer and the applications which run on
  203. it.  Scripts can make decisions based on user-interaction or by parsing and
  204. analyzing data, documents or situations.  Every Macintosh can be automated
  205. and controlled using AppleScript which comes with and is an integral part
  206. of the Macintosh operating system.
  207.  
  208.                                     -- <http://www.apple.com/applescript/>
  209.  
  210.                C Example
  211.  
  212. C mode, for the C programming language.
  213.  
  214. "C.Example.r"                   "C Help"
  215.  
  216. C was developed out of the construction of the UNIX operating system.  It
  217. has a modular programming structure and is thus useful in object oriented
  218. programming, as well as in developing graphical user interfaces.  C++ is a
  219. superset of C. Other dialects include Small-C and Visual C.
  220.  
  221.                                                         -- UMLF
  222.                C++ Example
  223.  
  224. C++ mode, for the C++ programming language.
  225.  
  226. "C++ Example.c"                 "C++ Help"
  227.  
  228. C++ was designed and implemented by Bjarne Stroustrup at AT&T Bell
  229. Laboratories to combine the organizational and design strengths of Simula
  230. with C's facilities for systems programming.  The initial version of C++,
  231. called "C with Classes," was first used in 1980; it supported traditional
  232. system programming techniques and data abstraction.  The basic facilities
  233. for object-oriented programming were added in 1983 and object-oriented
  234. design and programming techniques were gradually introduced into the C++
  235. community.  The language was first made commercially available in 1985. 
  236. Facilities for generic programming were added to the language in the
  237. 1987-1989 time frame.
  238.  
  239. As the result of widespread use and the appearance of several independently
  240. developed C++ implementations, formal standardization of C++ started in
  241. 1990 under the auspices of the American National Standards Institute, ANSI,
  242. and later the International Standards Organization, ISO, leading to an
  243. international standard in 1998.  During the period of standardization the
  244. standards committee acted as an important focus for the C++ community and
  245. its draft standards acted as interim definitions of the language.
  246.  
  247.                                         -- <http://www.research.att.com/~bs/>
  248.  
  249.                Caml Example
  250.  
  251. Caml mode, for the Caml programming language.
  252.  
  253. "Caml Example.ml"               "Caml Help"
  254.  
  255. Caml is a programming language, easy to learn, easy to use, and yet
  256. amazingly powerful.  It has been developed and distributed by INRIA (the
  257. main french research institute for computer science), since 1984.  It is
  258. freely available for Unix, PC or Macintosh.  There exist two flavors of
  259. Caml: Caml Light and Objective Caml.  Caml Light is merely a subset of
  260. Objective Caml, especially designed for teaching and learning the art of
  261. programming.  In addition to the Caml Light's core language, Objective Caml
  262. features a powerful modules system, full support to object-oriented
  263. paradigm, and an optimizing compiler.  
  264.  
  265.                                         -- <http://pauillac.inria.fr/caml/>
  266.  
  267.                Csh Example
  268.  
  269. Csh mode, for unix environment shell scripts.
  270.  
  271. "Csh Example.csh"               "Csh Help"
  272.  
  273. The first version of UNIX was created in 1969 by Kenneth Thompson and
  274. Dennis Ritchie, system engineers at AT&T's Bell Labs.  It went through many
  275. revisions and gained in popularity until 1977, when it was first made
  276. commercially available by Interactive Systems Corporation.
  277.  
  278. At the same time a team from the University of California at Berkeley was
  279. working to improve UNIX. In 1977 it released the first Berkeley Software
  280. Distribution, which became known as BSD. Over time this won favour through
  281. innovations such as the C shell.
  282.  
  283. Meanwhile the AT&T version was developing in different ways.  The 1978
  284. release of Version 7 included the Bourne Shell for the first time.  By 1983
  285. commercial interest was growing and Sun Microsystems produced a UNIX
  286. workstation.  System V appeared, directly descended from the original AT&T
  287. UNIX and the prototype of the more widely used variant today.
  288.  
  289.                                             -- <http://unixhelp.ed.ac.uk/>
  290.                FORTRAN Example
  291.  
  292. Fort mode, for the FORTRAN programming language.
  293.  
  294. "FORTRAN Example.f"             "Fort Help"
  295.  
  296. FORTRAN first developed in the 1950's and still used today.  Its name comes
  297. from "formula translation," revealing its early use in processing
  298. mathematics.  Dialects include FORTRAN 77and FORTRAN 90.  Versions include
  299. FORTRAN II, IV, and V, WATFOR, and WATFIV.
  300.  
  301.                                                         -- UMLF
  302.  
  303.                Gnuplot Example
  304.  
  305. GPLT mode, to use Alpha as the front end for Gnuplot.
  306.  
  307. "Gnuplot Example.gp"            "GPLT Help"
  308.  
  309. Gnuplot is a command-line driven interactive function plotting utility for
  310. UNIX, MSDOS, and VMS platforms.  The software is copyrighted but freely
  311. distributed (i.e., you don't have to pay for it).  It was originally
  312. intended as a graphical program which would allow scientists and students
  313. to visualize mathematical functions and data.
  314.  
  315.                         -- <http://www.cs.dartmouth.edu/gnuplot_info.html>
  316.  
  317.                Igor Example
  318.  
  319. Igor mode, for the IGOR data analysis and graphing package.
  320.  
  321. "Igor Example.igor"             "Igor Help"
  322.  
  323. WaveMetrics' IGOR Pro is an extraordinarily powerful and extensible
  324. graphing, data analysis, and programming tool for scientists and engineers.
  325.  
  326. With IGOR Pro installed on your Macintosh or Windows computer, you will
  327. have the power to produce journal-quality scientific graphs, handle large
  328. data sets with ease, import data from a variety of file formats, use a wide
  329. range of capabilites for analysis and graphing, present your results
  330. effectively, use IGOR's built-in programming environment to control all its
  331. aspects, and acquire data directly from instruments.
  332.  
  333.                                             -- <http://www.wavemetrics.com/>
  334.  
  335.                Java Example
  336.  
  337. Java mode, for the Java programming language.
  338.  
  339. "Java Example.java"             "Java Help"
  340.  
  341. Java is a computer language, but very powerful, intended to be machine and
  342. operating-system independent.  Java will enable whatever functions the
  343. piece you call up or download has, including sound, video, etc., on your
  344. screen.  It also is interactive, and can produce dynamic images on your
  345. screen, not just static ones.  It was developed by Sun Micro.  There is a
  346. dialect called Hot Java, and also a newer one having pages that move,
  347. called Dynamic HTML or DHTML.
  348.  
  349.                                                         -- UMLF
  350.  
  351.                Lisp Example
  352.  
  353. Lisp mode, for emacs .el (and other LISP) files.
  354.  
  355. "Lisp Example.el"               "Lisp Help"
  356.  
  357. LISP is an acronym for LISt Processing.  Its development history has often
  358. been associated with symbolic processing and with both computer and human
  359. languages.  A heterogeneous list data type has always been built into the
  360. language in order to efficiently deal with arbitrary and changing models. 
  361. Lisp has evolved into a family of languages.  The two major dialects in use
  362. today are Common Lisp and Scheme.
  363.  
  364.                                             -- <http://www.lisp.org>
  365.  
  366.                MATLAB Example
  367.  
  368. MATL mode, to use Alpha as the front end for MATLAB.
  369.  
  370. "MATLAB.Example.m"              "MATL Help"
  371.  
  372. MATLAB is an intuitive language and a technical computing environment.  It
  373. provides core mathematics and advanced graphical tools for data analysis,
  374. visualization, and algorithm and application development.  With more than
  375. 500 mathematical, statistical, and engineering functions, engineers and
  376. scientists rely on the MATLAB environment for their technical computing
  377. needs.
  378.  
  379.                                             -- <http://www.mathworks.com/>
  380.  
  381.                Metafont Example
  382.  
  383. Mf mode, to use Alpha as the front end for Metafont (with CMacTeX or OzTeX).  
  384.  
  385. "Metafont Example.mf"           "Mf Help"
  386.  
  387. Metafont is the programming language written, as a companion to TeX, by
  388. Donald Knuth in order to create characters, fonts, font families (and many
  389. others things).  Metafont allows you to write the source files which TeX
  390. and Latex will invoke at runtime to build the fonts they need: fonts are
  391. built according to the desired size and to the resolution of your printer
  392. in order to get printed documents with the highest typographic quality.
  393.  
  394.                                     -- <http://perso.easynet.fr/~berdesg/>
  395.  
  396.                Metapost Example
  397.  
  398. Mp mode, to use Alpha as the front end for Metapost (with CMacTeX or OzTeX).  
  399.  
  400. "Metapost Example.mp"           "Mp Help"
  401.  
  402. Metapost is a programming language written by John Hobby in order to create
  403. all kinds of figures, graphs, pictures to include in a document prepared
  404. with TeX or with Troff.  Its syntax is very much like Metafont's syntax but
  405. Metapost outputs are Postscript encapsulated files.
  406.  
  407.                                     -- <http://perso.easynet.fr/~berdesg/>
  408.  
  409.                Modula-2 Example
  410.  
  411. M2 mode, for programming in Modula-2 using the RAMSES or MacMETH shell.
  412.  
  413. "M2 Example.m2"                 "M2 Help"
  414.  
  415. The RAMSES (Research Aids for Modelling and Simulation of Environmental
  416. Systems) software is a package consisting of a shell, and several so-called
  417. sessions.  Each session serves a particular purpose, modeling, experiment
  418. definition, simulation, and post-simulation analysis and can be run from
  419. within the shell.
  420.  
  421. Modula-2 for the Macintosh is available as FreeWare, courtesy ETH Zurich as 
  422. part of the software packages RAMSES or MacMETH.
  423.  
  424.                                     -- <http://www.ito.umnw.ethz.ch/SysEcol/>
  425.  
  426.                Omega Example
  427.  
  428. Omg mode, for (TeX) Omega syntax files.
  429.  
  430. "Omega Example.opl"             "Omg Help"
  431.  
  432. OMEGA is the program written, as a superstructure of TeX, by John Plaice
  433. and Yannis Haralambous in order to extend TeX's capabilities and deal with
  434. any possible language and script.  It is based internally on Unicode.
  435.  
  436.                                     -- <http://perso.easynet.fr/~berdesg/>
  437.  
  438. Omg mode recognizes .tex, .opl, and .otp files.  Some of the mode's
  439. features (such as file marking) are file extension dependent.  The
  440. example-hyperlink will not have any such file extension -- for additional 
  441. Omega examples, try these links:
  442.  
  443. .tex    "Omega-Example.tex"
  444. .opl    "Omega-Example.opl"
  445. .otp    "Omega-Example.otp"
  446.  
  447.  
  448.                Pascal Example
  449.  
  450. Pasc mode, for the Pascal programming language.
  451.  
  452. "Pascal Example.p"              "Pasc Help"
  453.  
  454. The computer language Pascal was developed between 1968 and 1971, from
  455. ALGOL. It was named for the French mathematician Blaise Pascal.  Its
  456. highly-structured nature makes it especially well-suited for developing
  457. algorithms.
  458.  
  459.                                                         -- UMLF
  460.  
  461.                Perl Example
  462.  
  463. Perl mode, which can use Alpha as the front end for MacPerl.
  464.  
  465. "Perl Example.pl"               "Perl Help"
  466.  
  467. Perl is an interpreted high-level programming language developed by Larry
  468. Wall.  According to Larry, he included in Perl all the cool features found
  469. in other languages and left out those features that weren't so cool.
  470.  
  471. Perl has become the premier scripting language of the Web, as most CGI
  472. programs are written in Perl.  However, Perl is widely used as a rapid
  473. prototyping language and a "glue" language that makes it possible for
  474. different systems to work well together.  Perl is popular with system
  475. administrators who use it for an infinite number of automation tasks.
  476.  
  477. Perl's roots are in UNIX but you will find Perl on a wide range of
  478. computing platforms.  Because Perl is an interpreted language, Perl
  479. programs are highly portable across systems.
  480.  
  481.                                             -- <http://www.perl.com>
  482.  
  483.                PostScript Example
  484.  
  485. PS mode, for Postscript files.  This example is a PostScript version of 
  486. the first four pages of the Getting Started With LaTeX manual.
  487.  
  488. "PostScript Example.ps"         "PS Help"
  489.  
  490. PostScript is a language, not a graphic file format.  A PostScript file is
  491. really a program, not graphical data.  The difference is that by looking at
  492. a PostScript file you (or an application) cannot easily tell what the file
  493. represents.  Instead, you must run the file to see what it does. 
  494. Generally, the result of running a PostScript program is to draw marks on a
  495. graphical page.
  496.  
  497.                             -- <http://www.glyphic.com/free/macgs.html>
  498.  
  499.                Python Example
  500.  
  501. Pyth mode, for the Python programming language.
  502.  
  503. "Python Example.py"             "Pyth Help"
  504.  
  505. Python is an interpreted, interactive, object-oriented programming
  506. language.  It incorporates modules, exceptions, dynamic typing, very high
  507. level dynamic data types, and classes.  Python combines remarkable power
  508. with very clear syntax.  It has interfaces to many system calls and
  509. libraries, as well as to various window systems, and is extensible in C or
  510. C++.  It is also usable as an extension language for applications that need
  511. a programmable interface.  Finally, Python is portable: it runs on many
  512. brands of UNIX, on the Mac, and on PCs under MS-DOS, Windows, Windows NT,
  513. and OS/2.
  514.                                             -- <http://www.python.org>
  515.  
  516.                S Example
  517.  
  518. S mode, for S, S-Plus, R statistical syntax files.
  519.  
  520. "S Example.s"                   "S Help"
  521.  
  522. S-Plus is the premier solution for exploratory data analysis and
  523. statistical modeling.  With over 3,800 data analysis functions, including
  524. the most comprehensive set of robust and modern methods available anywhere,
  525. S-Plus allows you to perform more insightful analysis, create revealing
  526. graphics and make more informed business decisions.
  527.  
  528.                                     -- <http://www.splus.mathsoft.com/>
  529.  
  530.                SAS Example
  531.  
  532. SAS mode, for SAS statistical syntax files.
  533.  
  534. "SAS Example.sas"               "SAS Help"
  535.  
  536. SAS/STAT software, an integral component of the SAS System, provides
  537. extensive statistical capabilities with tools for both specialized and
  538. enterprise-wide analytical needs.  Ready-to-use procedures handle a wide
  539. range of statistical analyses, including analysis of variance, regression,
  540. categorical data analysis, multivariate analysis, survival analysis,
  541. psychometric analysis, cluster analysis, and nonparametric analysis.
  542.  
  543.                                             -- <http://www.sas.com>
  544.  
  545.                Scheme Example
  546.  
  547. Scm mode, for the Scheme programming language.
  548.  
  549. "Scheme Example.scm"            "Scm Help"
  550.  
  551. The Scheme dialect of Lisp was created in 1975 by Guy Steele and Gerry
  552. Sussman to explore ideas in programming-language semantics.  They showed
  553. that a powerful language can be made "not by piling feature on top of
  554. feature, but by removing the weaknesses and restrictions that make
  555. additional features appear necessary".  Scheme pioneered lexical scope in
  556. Lisp, first-class continuations, and tail recursion, and more recently
  557. added an advanced macro system.  It's the best-known Lisp dialect after
  558. Common Lisp (which it influenced).  It is IEEE standardized and widely used
  559. in universities and in electronic CAD systems.
  560.  
  561.                                             -- <http://www.lisp.org>
  562.  
  563.                Scilab Example
  564.  
  565. Scil mode, for the Scilab scientific software package, used for numerical
  566. computations in a user-friendly environment.
  567.  
  568. "Scilab Example.sci"            "Scil Help"
  569.  
  570. Its features include elaborate data structures (polynomial, rational and
  571. string matrices, lists, multivariable linear systems,...); sophisticated
  572. interpreter and programming language with Matlab-like syntax; hundreds of
  573. built-in math functions (new primitives can easily be added); stunning
  574. graphics (2d, 3d, animation); open structure (easy interfacing with Fortran
  575. and C via online dynamic link); and many built-in libraries.
  576.  
  577.                                     -- <http://www-rocq.inria.fr/scilab/>
  578.  
  579.                Setext Example
  580.  
  581. Setx mode, for the Setext programming language. This example also serves 
  582. as the mode's manual.
  583.  
  584. "Setext Example.stx"            "Setx Help"
  585.  
  586. Setext stands for Structure Enhanced Text.  It is a markup scheme for plain
  587. text documents such as email messages and e-zines.  Setext's primary goal
  588. is to provide a way of marking text that is visually unobtrusive, so that
  589. if you don't have a special setext browser, like EasyView, you can still
  590. read the text.
  591.                                             -- Donavan Hall
  592.                                             
  593.                SPSS Example
  594.  
  595. SPSS mode, for SPSS statistical syntax files.
  596.  
  597. "SPSS Example.sps"              "SPSS Help"
  598.  
  599. SPSS 10.0 is a modular, integrated product line for data access, data
  600. preparation, reporting, graphics and advanced analysis through statistical
  601. techniques.  The new release updates Macintosh users to the latest version
  602. and delivers significant new capabilities in all areas of the product line,
  603. including: new modules; predictive capabilities for data mining; and
  604. dynamic, interactive graphics for the first time on the Macintosh.  The
  605. software will also be available in a distributed analysis architecture
  606. (DAA), which provides users with dramatically improved performance with
  607. very large datasets.
  608.  
  609.                                             -- <http://www.spss.com>
  610.  
  611.                SQL Example
  612.  
  613. SQL mode, for SQL and Oracle's PL/SQL programming language.
  614.  
  615. "SQL Example.sql"               "SQL Help"
  616.  
  617. SQL, Structured Query Language, is a database query language that was
  618. adopted as an industry standard in 1986.  PL/SQL is Oracle's Procedural
  619. Language extension to SQL. PL/SQL's language syntax, structure and data
  620. types are similar to that of Ada.  The language includes object oriented
  621. programming techniques such as encapsulation, function overloading,
  622. information hiding (all but inheritance) and is commonly used to write
  623. data-centric programs to manipulate Oracle data.
  624.  
  625.                                             -- <http://www.orafaq.org/>
  626.  
  627.                Stata Example
  628.  
  629. Stta mode, for Stata statistical syntax files.
  630.  
  631. "Stata Example.do"              "Stta Help"
  632.  
  633. Stata has complete statistical, graphical, and data-management capabilities
  634. and is also fully programmable.  Stata is an environment for manipulating
  635. and analyzing data using statistical and graphical methods.  Stata is an
  636. integrated package — not a collection of separate modules.  You can
  637. intersperse data management, statistical, and graphical commands.
  638.  
  639.                                             -- <http://www.stata.com>
  640.                Tcl Example
  641.  
  642. Tcl mode, the programming language on which Alpha is based.  Tcl has its 
  643. own separate "Tcl Commands" and "Tcl Resources" help files.
  644.  
  645. "Tcl Example.tcl"                "Tcl Help"
  646.  
  647. Tcl is a string-based command language.  The language has only a few
  648. fundamental constructs and relatively little syntax, which makes it easy to
  649. learn.  The Tcl syntax is meant to be simple.  Tcl is designed to be a glue
  650. that assembles software building blocks into applications.  A simpler glue
  651. makes the job easier.  In addition, Tcl is interpreted when the application
  652. runs.  The interpreter makes it easy to build and refine your application
  653. in an interactive manner.  
  654.  
  655.                                             -- <http://www.scriptics.com>
  656.  
  657.           
  658.     ======================================================================
  659.  
  660.  
  661.  
  662.           Alpha -- specific modes
  663.  
  664.  
  665. Some of Alpha's mode are not intended for text editing.  They instead 
  666. support different menu items or features.  This section gives examples of 
  667. how Alpha might use some of the modes included in the pop-up menu, the one 
  668. in the status bar that currently reads Text.
  669.  
  670.  
  671.                Browser Example
  672.  
  673. Brws mode.  This provides a way to navigate the results of a batch search. 
  674. During a batch search, a list of all matching lines are displayed in a Brws
  675. window.  By using the arrow keys and the return key, you can easily jump to
  676. the correct file and line of the match you desire.
  677.  
  678. "Browser Example"
  679.  
  680. This example is a hyperlink to the 'Browse Fileset' menu item.
  681.  
  682.  
  683.                Calculator Example
  684.  
  685. Calc mode.  This provides a simple calculator for use within Alpha,
  686. available as a dynamic menu item under Utils.  See the "Alpha Manual" for
  687. more information regarding dynamic menus.
  688.  
  689. "Calculator Example"            "Calculator Help"
  690.  
  691. This example will return the result of typing  
  692.  
  693.     1 <cr> 1 + <cr>
  694.     1 <cr> 1 + <cr> 4.2 *
  695.  
  696. It first calculates 1 + 1, then calculates (1 + 1) * 4.2
  697.  
  698.  
  699.                Changes Example
  700.  
  701. Chng mode, an Alpha Developers tool for editing 'Changes' files.  This link 
  702. will open the latest Alpha - Changes file.
  703.  
  704. "Changes Example"
  705.  
  706.  
  707.                Compare Example
  708.  
  709. Diff mode.  This is a display mode associated with the compare package,
  710. which allows for powerful side-by-side file comparison.
  711.  
  712. "Compare Example"               "Diff Help"
  713.  
  714. This link will compare the Tcl-Example.tcl file with the tclMode.tcl file
  715. installed with your distribution.
  716.  
  717.  
  718.                Filters Example
  719.  
  720. Flt mode.  The Filters Menu allows you to do successive Search And Replace
  721. operations for the current window (in any mode).  All the operations are
  722. gathered in files called << filters >> which you can apply to any text file
  723. opened in Alpha.
  724.  
  725. "Filters Example"               "Filters Help"
  726.  
  727. This link will open a Filters Tutorial shell window.  The actual files 
  728. containing the filter information are opened in Flt mode, such as the 
  729. "Filters Example.flt" file.  These examples will be much more useful if the 
  730. Filters package is enable via the "Config --> Menus" menu item.
  731.  
  732.  
  733.                Install Example
  734.  
  735. Inst mode.  This provides support for the Install menu, and is invoked 
  736. whenever you open a file containing an installation script, i.e. whenever 
  737. you are installing a new package.
  738.  
  739. "Install Example"               "Extending Alpha"
  740.  
  741. This link will open such a file, presenting you with installation options. 
  742. This script won't actually install anything, and clicking on either 'OK' or
  743. 'Cancel' will close the file.  To see the actual Tcl code contained in this
  744. script, hold down any modifier key while you click on the hyperlink.  See
  745. the "Extending Alpha" help file for more installation script information.
  746.  
  747.  
  748.                Mail Example
  749.  
  750. Mail mode.  This allows Alpha serve as a front end to Eudora and other
  751. e-mail software packages for reading and sending e-mail.
  752.  
  753. "Mail Example"                "Mail Help"
  754.  
  755. This link will open a mail window and compose a nice note addressed to the
  756. author of this file.  You must have Eudora or some other compatable
  757. software installed to send it, though.
  758.  
  759.  
  760.                ManipCols Example
  761.  
  762. This link doesn't actually demonstrate one of Alpha's modes, but is a  nice
  763. example of a package tutorial.
  764.  
  765. "ManipCols Example"             "ManipCols Help"
  766.  
  767. The 'manipCols' package is a feature which   allows  one  to   do   various
  768. manipulations with the columns of any tabulated material i.e. a  series  of
  769. lines in which items are separated by a tabulation or by any other specific
  770. character (like & or a tabulation or a colon, a comma, an  endash  etc.  or
  771. even the space character). Once it is installed and activated,  it  adds  a
  772. "Text --> Columns" submenu.  The  items  of  this submenu are explained  in
  773. the "ManipCols Help" file.
  774.  
  775.  
  776.                Shell Example
  777.  
  778. Shel mode.  This provides an interactive way (via Utils --> Shell) to access 
  779. Tcl and the Toolserver shells.
  780.  
  781. "Shell Example"                 "Shells"
  782.  
  783. This link will open a Tcl shell and issue the commands 
  784.  
  785.     cd [file join $HOME]
  786.     cd [file join $HOME "Mode Examples"]
  787.     glob -dir [file join $HOME "Mode Examples"] *
  788.     version
  789.     alertnote "Hello World."
  790.  
  791. Some of these commands are Tcl commands, others are specific to Alpha.
  792.  
  793.  
  794.                TIP Example
  795.  
  796. TIP mode, for Tcl Improvement Proposal suggestions.
  797.  
  798. "TIP Example.tip"                   "TIP Help"
  799.  
  800. This link will open a draft letter for a suggestion, and insert the TIP menu 
  801. into the menu bar.
  802.  
  803.  
  804.                WWW Example
  805.  
  806. WWW mode -- this is another of Alpha's display modes.  The WWW Menu allows
  807. you to render local HTML files directly in an Alpha text window.  The
  808. hyperlinks in the WWW window can be navigated with the arrow keys; the
  809. return key takes you to the target of the link if you have your preferences
  810. set to do that.  A future version of Alpha will support direct browsing of
  811. the Internet, but in versions less than 8.0 only local files can be
  812. rendered.
  813.  
  814. "WWW Example"                   "wwwMenu Help"
  815.  
  816. This link document will render the first page of the HTML Mode Manual.  
  817.  
  818.           
  819.     ======================================================================
  820.  
  821.  
  822.           Acknowledgments
  823.  
  824.  
  825. Alpha is a collaborative project.  This package would not have been possible 
  826. without the suggestions and submitted/authored files from the following:
  827.  
  828.     Anders Andersen, Milton Aupperle, Dale Bickel, Laurent Chéno, Vince
  829.     Darley, Bernard Desgraupes, Thomas Dunbar, Andreas Fischlin, David
  830.     Flanagan, Jonathon Guyer, Donavan Hall, Yannis Haralambous, Johan Linde,
  831.     John Plaice, Neil Schemenauer, Sandra Silcot, Dorai Sitaram, David Smith,
  832.     Bjarne Stroustrup, David A. Wheeler, Pierre Weis, David Wilkins, and Jos
  833.     van der Woude
  834.         
  835.         
  836.           Technical Notes
  837.  
  838.  
  839. The hyperlinks in this document use the modeExamplesScript.tcl file (in the
  840. Mode Examples folder).  Any Help file can take advantage of this script to
  841. include hyperlinks to any mode example.  
  842.  
  843. Any file with 'Example' in the filename will automatically be installed in
  844. the Mode Examples folder.
  845.  
  846. Important: 'Example' filenames must be '<something>-Example.sfx', where
  847. <something> is an alpha-numeric string and .sfx is recognized by Alpha in
  848. the "Config --> Preferences --> Suffix Mappings" preference.  (Or include a
  849.  
  850.     -*-<mode>-*-
  851.  
  852. statement in the first line of the example file as in
  853.  
  854.     -*-Omg-*-
  855.  
  856. The dash in the filename is important and cannot be omitted !!
  857.  
  858. This file relies on the auto-marking and auto-hyperizing capabilities of
  859. Alpha.  To include an 'example' hyperlink in any Help file, which will open
  860. any file in the Mode Examples folder in read-only format, simply put the
  861. file's name in quotes:
  862.  
  863.     "LaTeX-Example.tex"
  864.  
  865. To open the example in a shell window, which will insert some explanatory
  866. comments at the top of the window and allow for any modifications without
  867. altering the original file, omit the dash preceding Example in the file's 
  868. name:
  869.  
  870.     "LaTeX Example.tex"
  871.  
  872. Note that examples which are opened in shell windows do not technically
  873. exist as files, and the window will not have any file suffix.  This could
  874. disable some mode features that rely on file suffixes, and the window can
  875. not be sent to other applications.  
  876.  
  877. If you want to include an example that does something different than these
  878. two default routines, you must create a "<something>-Example.sfx.tcl" file. 
  879. The alpha-specific modes use such scripts (i.e. "Compare Example" sources
  880. "Compare-Example.tcl").  These can also be adapted for package-specific
  881. tutorials, such as the tutorials
  882.  
  883.     "Filters Example"       "Filters-Example.tcl"    and
  884.     "ManipCols Example"     "ManipCols-Example.tcl"
  885.  
  886. See some of the .tcl files in the "Mode Examples" folder for more examples.
  887.  
  888.  
  889. Auto-marking / hyperizing files must be "clean" before they are opened
  890. through the Help menu -- that is, they must not have any colors, hypers or
  891. marks in them.  If this is the case, Alpha will perform a series of "search
  892. and hyperize" routines in the proc: help::colourHeadingsEtc.
  893.  
  894. These routines makes writing Help files much easier -- no need to
  895. individually "Link To File" anymore !!  (This means that help files can
  896. also be marked and hyperized by Alphatk.)  See the proc: helpMenu and the
  897. file "Help Files Help" for more information.
  898.  
  899.  
  900.           To submit additional examples,
  901.  
  902.  
  903. or just better ones, please send them via e-mail to the address below.  
  904. All of .bin or .hqx attachments, and in-line text files are acceptable.
  905.  
  906. This would include, of course, examples of modes that aren't even listed
  907. above.  Please include information on where one could obtain the mode if it
  908. is not included in standard distributions.
  909.  
  910. The most recent version should be available at Vince's upload site, at
  911.  
  912.     <ftp://ftp.ucsd.edu/pub/alpha/>
  913.  
  914. Feel free to also send me any bugs, comments, or suggestions on this file.
  915.  
  916. cheers,
  917.  
  918.  
  919. -- cbu
  920.  
  921.  
  922. Author: Craig Barton Upright
  923. E-mail: <cupright@princeton.edu>
  924.   mail: Princeton University,  Department of Sociology
  925.         Princeton, New Jersey  08544
  926.    www: <http://www.princeton.edu/~cupright/>
  927.  
  928.  
  929.           License and Disclaimer
  930.  
  931.  
  932. This library is free software; you can redistribute it and/or modify it
  933. under the terms of the GNU Library General Public License as published by
  934. the Free Software Foundation; either version 2 of the License, or (at your
  935. option) any later version.
  936.  
  937. This library is distributed in the hope that it will be useful, but WITHOUT
  938. ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  939. FITNESS FOR A PARTICULAR PURPOSE. See the GNU Library General Public
  940. License for more details.
  941.  
  942. You should have received a copy of the GNU Library General Public License
  943. along with this library; if not, write to the Free Foundation, Inc., 59
  944. Temple Place, Suite 330, Boston, MA 02111-1307 USA
  945.  
  946. This package is free.  Alpha is shareware ! <<register>>
  947.  
  948.